slack-client

Node.js Slack Client Library

node-slack v2.0.0 please read!

Hi all,

First of all, thanks for using this library :) We really appreciate all the developers out there who want to integrate with Slack and build cool bots and tools.

I've been working on a substantial refactor of the existing node-client library for the past little while and it's now at the point where getting your feedback would be fantastic.

That refactor is located on my personal github.

The refactor has 3 main goals:

• get node-slack to a point where it can be easily maintained and extended, both by Slack and our delightful external contributors:
  • improve test coverage
  • standardize code; e.g. move off coffee script, make heavier use of npm modules etc.
  • update JSDoc, code comments and inline documentation
• address flaws in the existing client, e.g.
  • improve reconnection logic
  • respect 429 headers
  • improve the client so that it can be used as the foundation for more complex apps and use cases, e.g. design to support different types of datastores
• add documentation, examples and test apps

There are still some issues outstanding on the refactor, which can be seen here

What would be great to get some help on is:

• code review; please check out the code and raise any issues you run into
• test it out; it would be great to get a few test applications written to shake out any bugs, or if you have an app already to see

Travis-CI Build Status

Description

This is a Slack client library for Node.js. It's intended to expose all of the functionality of Slack's Real Time Messaging API while providing some common abstractions and generally making your life easier, if you want it to.

This code has been built to support our hubot-slack adapter. Most other functionality isn't yet supported, and documentation is minimal, at best.

Installation

npm install slack-client --save

Usage

Slack = require 'slack-client'

slackToken = 'xoxb-YOUR-TOKEN-HERE' # Add a bot at https://my.slack.com/services/new/bot and copy the token here.
autoReconnect = true # Automatically reconnect after an error response from Slack.
autoMark = true # Automatically mark each message as read after it is processed.

slack = new Slack(slackToken, autoReconnect, autoMark)

slack.on 'open', ->
    console.log "Connected to #{slack.team.name} as @#{slack.self.name}"

slack.on 'message', (message) ->
    console.log message

slack.on 'error', (err) ->
    console.error "Error", err

slack.login()

A full example of how to use this module from Node.js can be found in the /examples directory.

Contribute

Here's the most direct way to get your work merged into the project.

1. Fork the project
2. Clone down your fork
3. Create a feature branch
4. Hack away and add tests, not necessarily in that order
5. Make sure everything still passes by running tests
6. If necessary, rebase your commits into logical chunks without errors
7. Add yourself to package.json as a contributor
8. Push the branch up to your fork
9. Send a pull request for your branch

Copyright

Copyright © Slack Technologies, Inc. MIT License; see LICENSE for further details.

TODOs

1. Better/any timeouts on initial websocket connection
2. Better/any timeouts on API calls
3. Document the connection options, etc
4. Emit more events around unreads and mentions